Skip to content

docs(context): align inline comments in GetPostForm example#4675

Merged
appleboy merged 1 commit into
gin-gonic:masterfrom
leehainuo:docs/align-getpostform-comment
Jun 2, 2026
Merged

docs(context): align inline comments in GetPostForm example#4675
appleboy merged 1 commit into
gin-gonic:masterfrom
leehainuo:docs/align-getpostform-comment

Conversation

@leehainuo
Copy link
Copy Markdown

@leehainuo leehainuo commented May 28, 2026

Description

This PR improves the formatting consistency of inline comments in the GetPostForm function documentation example.

Changes

  • Align inline comments in GetPostForm example code (lines 622-623)
  • Improve visual consistency and readability of the documentation

Before:

//	    email=mail@example.com  -->  ("mail@example.com", true) := GetPostForm("email") // set email to "mail@example.com"
//		   email=                  -->  ("", true) := GetPostForm("email") // set email to ""
//	                            -->  ("", false) := GetPostForm("email") // do nothing with email

After:

//	    email=mail@example.com  -->  ("mail@example.com", true) := GetPostForm("email") // set email to "mail@example.com"
//		email=                  -->  ("", true) := GetPostForm("email")                 // set email to ""
//	                            -->  ("", false) := GetPostForm("email")                // do nothing with email

Motivation

  • Maintain consistent comment formatting across documentation
  • Improve code readability for developers reading the documentation

Testing

  • All existing tests pass
  • No functional code changes, documentation only

Pull Request Checklist

Please ensure your pull request meets the following requirements:

  • Open your pull request against the master branch.
  • All tests pass in available continuous integration systems (e.g., GitHub Actions).
  • Tests are added or modified as needed to cover code changes.
  • If the pull request introduces a new feature, the feature is documented in the docs/doc.md.

Thank you for contributing!

@leehainuo
docs(context): align inline comments in GetPostForm example
b73528c 
Standardize comment alignment in GetPostForm documentation example
to improve readability and maintain consistency with code formatting
conventions.
@codecov
Copy link
Copy Markdown

codecov Bot commented May 28, 2026 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.37%. Comparing base (3dc1cd6) to head (b73528c).
⚠️ Report is 276 commits behind head on master.

Additional details and impacted files 
@@            Coverage Diff             @@
##           master    #4675      +/-   ##
==========================================
- Coverage   99.21%   98.37%   -0.84%     
==========================================
  Files          42       48       +6     
  Lines        3182     3138      -44     
==========================================
- Hits         3157     3087      -70     
- Misses         17       42      +25     
- Partials        8        9       +1
Flag Coverage Δ
?
--ldflags="-checklinkname=0" -tags sonic 98.36% <ø> (?)
-tags go_json 98.29% <ø> (?)
-tags nomsgpack 98.35% <ø> (?)
go-1.18 ?
go-1.19 ?
go-1.20 ?
go-1.21 ?
go-1.25 98.37% <ø> (?)
go-1.26 98.37% <ø> (?)
macos-latest 98.37% <ø> (-0.84%) ⬇️
ubuntu-latest 98.37% <ø> (-0.84%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@appleboy appleboy added this to the v1.13 milestone Jun 2, 2026
@appleboy appleboy merged commit 88c4263 into gin-gonic:master Jun 2, 2026
26 of 27 checks passed
Premiermoney added a commit to Premiermoney/gin that referenced this pull request Jun 4, 2026
@Premiermoney @wanghaolong613
@raju-mechatronics @leehainuo @tsaarni @SAY-5 @appleboy
G (#4)
f971470 
* refactor: optimize error message concatenation in default_validator (gin-gonic#4685)

* feat(context): add Scheme() with proper reverse proxy support (gin-gonic#4655)

* feat(context): add Scheme method to determine HTTP scheme from request

* test(context): add tests for Scheme method

* docs(context): align inline comments in GetPostForm example (gin-gonic#4675)

Standardize comment alignment in GetPostForm documentation example
to improve readability and maintain consistency with code formatting
conventions.

* chore(deps): bump golang.org/x/net to v0.55.0 (gin-gonic#4678)

Signed-off-by: Tero Saarni <tero.saarni@est.tech>

* fix(response): panic on Hijack/CloseNotify when wrapper unsupported (gin-gonic#4645)

* response_writer: don't panic on Hijack/CloseNotify when wrapper unsupported

Closes gin-gonic#4638. http.TimeoutHandler's writer doesn't implement http.Hijacker/CloseNotifier; mirror Flush's graceful degradation.

* response_writer: keep Written() false when Hijack is unsupported

Signed-off-by: Sai Asish Y <say.apm35@gmail.com>

---------

Signed-off-by: Sai Asish Y <say.apm35@gmail.com>
Co-authored-by: Bo-Yi Wu <appleboy.tw@gmail.com>

---------

Signed-off-by: Tero Saarni <tero.saarni@est.tech>
Signed-off-by: Sai Asish Y <say.apm35@gmail.com>
Co-authored-by: wanghaolong613 <wanghaolong613@163.com>
Co-authored-by: Raju Ahmed <73926176+raju-mechatronics@users.noreply.github.com>
Co-authored-by: Leehainuo <lihainuo0502@gmail.com>
Co-authored-by: Tero Saarni <tero.saarni@est.tech>
Co-authored-by: Sai Asish Y <say.apm35@gmail.com>
Co-authored-by: Bo-Yi Wu <appleboy.tw@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@appleboy appleboy appleboy approved these changes

Assignees

No one assigned

Labels

document

Projects

None yet

Milestone

v1.13

Development

Successfully merging this pull request may close these issues.

2 participants

@leehainuo @appleboy